/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015 ForgeRock AS.
 */
package org.forgerock.openam.entitlement.constraints;

/**
 * Captures the result of verifying some constraint.
 *
 * @since 13.0.0
 */
public interface ConstraintResult {

    /**
     * Whether the result represents a successful validation.
     *
     * @return whether the validation was successful
     */
    boolean isSuccessful();

    /**
     * Helpful method to throw an exception in the case of a constraint failure.
     *
     * @throws ConstraintFailureException
     *         if there is a constraint failures
     */
    void throwExceptionIfFailure() throws ConstraintFailureException;

}
